whisper: Improve support for local custom Whisper models #3988
+14
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated documentation about `custom_model` usage.
![home-assistant[bot]](https://avatars.githubusercontent.com/in/97978?s=60&v=4){kind=small}
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
home-assistant
bot
added
cla-recheck
cla-signed
and removed
cla-recheck
cla-needed
labels
Contributor
📝 Walkthrough## Walkthrough
The changes introduce updates to the Whisper add-on for Home Assistant, focusing on enabling and documenting support for local custom Whisper models. The changelog now includes a "2.5.0" section detailing these updates. The documentation has been expanded to provide clear instructions for users on how to use local custom models by copying them into a specific directory and referencing them correctly in the configuration. Additionally, the configuration file has been modified to include a new mapping that allows read-write access to the add-on's configuration directory.
## Changes
| File(s) | Change Summary |
|------------------------|------------------------------------------------------------------------------------------------------------|
| whisper/CHANGELOG.md | Added a "2.5.0" section with entries about local model configuration mapping and documentation updates. |
| whisper/DOCS.md | Expanded documentation for the `custom_model` option, including instructions for using local custom models and backup distinctions. |
| whisper/config.yaml | Updated version to 2.5.0; added a `map` section granting read-write access to the add-on config directory. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant User
participant HomeAssistant
participant WhisperAddon
User->>HomeAssistant: Copy custom Whisper model to /addon_configs/core_whisper/models/<model-dir>
User->>HomeAssistant: Set custom_model path to /config/models/<model-dir>
HomeAssistant->>WhisperAddon: Start add-on with updated config
WhisperAddon->>WhisperAddon: Access custom model from /config/models/<model-dir>
WhisperAddon-->>User: Use local custom Whisper model for operations |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
whisper/DOCS.md (1)
70-74: Normalize inline code formatting
The path snippet is wrapped in both quotes and backticks. Remove the extra quotes so the code renders cleanly:- "`/config/<your-model-dir>`". For a local model, the path must start with `/config/`, as this is how the add-on accesses your Home Assistant configuration directory through the container's mounted volume. + `/config/<your-model-dir>`. For a local model, the path must start with `/config/`, as this is how the add-on accesses your Home Assistant configuration directory through the container's mounted volume.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
whisper/CHANGELOG.md(1 hunks)whisper/DOCS.md(1 hunks)whisper/config.yaml(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure t...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
whisper/CHANGELOG.mdwhisper/config.yamlwhisper/DOCS.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - If "" are used to mark UI strings, replace them by bold.
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
whisper/CHANGELOG.mdwhisper/config.yamlwhisper/DOCS.md
`*/**(html|markdown|md)`: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
whisper/CHANGELOG.mdwhisper/config.yamlwhisper/DOCS.md
`*/**(html|markdown|md)`: - Use sentence-style capitalization also in headings.
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
whisper/CHANGELOG.mdwhisper/config.yamlwhisper/DOCS.md
`*/**(html|markdown|md)`: do not comment on HTML used for icons
*/**(html|markdown|md): do not comment on HTML used for icons
whisper/CHANGELOG.mdwhisper/config.yamlwhisper/DOCS.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
whisper/CHANGELOG.mdwhisper/config.yamlwhisper/DOCS.md
🔇 Additional comments (2)
whisper/config.yaml (1)
15-17: Add mapping for local‑model support
The newmapentry withtype: addon_configandread_only: falsecorrectly exposes/configfor custom Whisper models. Indentation and placement under the top‑level keys align with the add‑on manifest schema.whisper/CHANGELOG.md (1)
3-7: Document Unreleased changes
The## [Unreleased]section and its bullet entries accurately reflect the addition of the local‑model mapping and the documentation update forcustom_model. The format and placement at the top of the changelog match existing conventions.
agners
changed the title
agners
requested changes
Apr 22, 2025
Contributor
|
@DT-art1 The backup exclude rule is |
Contributor
Author
|
Thanks for pointing out the backup aspect. I agree that organizing custom models in a separate sub-directory could be a good approach, but I opted to add an additional rule /data/addon_configs/* to exclude local models from the backup entirely. I believe this approach is simpler and more user-friendly for those who may not have a dedicated sub-directory for their custom models. Let me know if you hare any further thoughts on this. Test output |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
whisper/DOCS.md (2)
70-73: Reorder instruction to front the action and improve clarity
The current phrasing leads with the goal; front the action for consistency with other steps. Consider collapsing into two concise sentences:Copy your local Whisper model directory into the add-on configuration at `/addon_configs/core_whisper/<your-model-dir>`. Set the `custom_model` option to `/config/<your-model-dir>`—the path must start with `/config/` so the container can access your Home Assistant configuration volume.
89-90: Remove weak intensifier and front the manual-copy action
Replace “quite large” with “large” and lead with the post-restore action. Example diff:- Whisper model files can be quite large, so they are automatically excluded from backups. The models will be re-downloaded when the backup is restored for a remote model. - If you're using a local custom Whisper model, you will need to manually copy the model directory again after restoring a backup. + Whisper model files can be large, so they are automatically excluded from backups and re-downloaded on restore for remote models. + After restoring a backup with a local custom Whisper model, manually copy your model directory again.🧰 Tools
🪛 LanguageTool
[style] ~89-~89: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... ## Backups Whisper model files can be quite large, so they are automatically excluded fro...(EN_WEAK_ADJECTIVE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
whisper/DOCS.md(2 hunks)whisper/config.yaml(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- whisper/config.yaml
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure t...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
whisper/DOCS.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - If "" are used to mark UI strings, replace them by bold.
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
whisper/DOCS.md
`*/**(html|markdown|md)`: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
whisper/DOCS.md
`*/**(html|markdown|md)`: - Use sentence-style capitalization also in headings.
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
whisper/DOCS.md
`*/**(html|markdown|md)`: do not comment on HTML used for icons
*/**(html|markdown|md): do not comment on HTML used for icons
whisper/DOCS.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
whisper/DOCS.md
🪛 LanguageTool
whisper/DOCS.md
[style] ~89-~89: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... ## Backups Whisper model files can be quite large, so they are automatically excluded fro...
(EN_WEAK_ADJECTIVE)
Contributor
|
Just want to confirm with @agners that the backup exclude rule will work. Otherwise, looks good to me 👍 |
agners
reviewed
Apr 28, 2025
agners
approved these changes
May 1, 2025
Member
|
LGTM, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
This updates the 'whisper' add-on to clarify how to configure and use a local custom Whisper model.
Changes:
custom_modelusage.Summary by CodeRabbit
Documentation
Chores